Skip to content

feat: Migrate metadata fetching to API v2 alpha #585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
anth-volk wants to merge 32 commits into
base: move-to-api-v2
Choose a base branch
from
Open

feat: Migrate metadata fetching to API v2 alpha #585

anth-volk wants to merge 32 commits into from

Conversation

@anth-volk
Copy link
Collaborator

@anth-volk anth-volk commented Jan 19, 2026

Fixes #584

Summary

This PR migrates the frontend to fetch metadata from the new PolicyEngine API v2 alpha endpoints. Key changes include:

  • V2 API Integration: New modules for fetching parameters, variables, datasets, and parameter values from V2 endpoints using tax_benefit_model_name (e.g., "policyengine-us") instead of UUIDs
  • Static Metadata Hooks: New useStaticMetadata hooks replace Redux selectors for accessing static data (regions, entities, currentLawId)
  • IndexedDB Caching: Updated to work with the new V2 data format
  • Component Migrations: Updated all components that were accessing removed MetadataState properties

Changes

New V2 API Modules (app/src/api/v2/)

File Purpose
taxBenefitModels.ts Country-to-model-name mapping and utilities
parameters.ts Fetch parameters with tax_benefit_model_name filter
variables.ts Fetch variables with tax_benefit_model_name filter
datasets.ts Fetch datasets with tax_benefit_model_name filter
parameterValues.ts Fetch parameter values by parameter ID

Static Metadata Migration

New useStaticMetadata.ts hooks provide:

  • useRegionsList(countryId, year) - Get available regions
  • useCurrentLawId(countryId) - Get current law policy ID
  • useEntitiesList(countryId) - Get entity definitions

Production Files Updated

File Change
useFetchReportIngredients.ts Use useRegionsList() instead of state.metadata.economyOptions.region
useSaveSharedReport.ts Use useCurrentLawId() instead of state.metadata.currentLawId
AbsoluteChangeByDistrict.tsx Use useRegionsList() for congressional district regions
RelativeChangeByDistrict.tsx Use useRegionsList() for congressional district regions

UI Improvements

  • Added loading states (Skeleton, LoadingOverlay) to parameter setter while values load

Type Fixes

  • Installed @types/topojson-client and @types/topojson-specification for choropleth map types

Tests

All tests updated to mock static metadata hooks instead of Redux:

  • useSaveSharedReport.test.tsx
  • AbsoluteChangeByDistrict.test.tsx
  • RelativeChangeByDistrict.test.tsx
  • New V2 API module tests

All mocks moved to tests/fixtures/ following project conventions.

Test plan

  • Run npm run typecheck - passes
  • Run npm test - all tests pass
  • Verify metadata loads correctly in development
  • Verify parameter values load with loading spinner
  • Verify congressional district maps display correctly

🤖 Generated with Claude Code

@anth-volk
feat: First IndexedDB implementation
c74559c
@anth-volk
feat: First API fetching code
b797a56
@anth-volk
feat: Loaders for parameters, variables, datasets
23f6075
@anth-volk
feat: Metadata bulk loading and tests
e34b97e
@anth-volk
feat: Metadata guard
614cff6
@anth-volk
feat: Static data
8025704
@anth-volk
feat: Regions
7d20af4
@anth-volk
feat: Begin using migrated metadata endpoints in existing hooks; fix …
38635e1 
…static data issues
@anth-volk
fix: Remove unused function
1d76ec9
@anth-volk
test: Add tests
628e990
@anth-volk
fix: Fix imports
07bb8d6
@anth-volk
fix: Continue fixing metadata to use one-stage loading approach
3d93f24
@anth-volk
test: Fix tests
c3dd97e
@anth-volk
test: Update tests
3dd9926
@anth-volk
fix: Fix loading into IndexedDB
bb2fc8e
@anth-volk
fix: Rename metadata loader; remove unneeded compatibility features
72f73c4
@anth-volk
fix: Move toward saving v2 variables and params in Redux
59d988f
@anth-volk
feat: Fetch parameter values from API v2
4d84c9c
@anth-volk
test: Add tests
d176351
@anth-volk
feat: Use new parameter value features
90ad5ba
@anth-volk
fix: Properly pass metadata to household overview page in report output
fd162d7
@anth-volk
fix: Fix current law IDs
7e4bbf0
@anth-volk
fix: Create new param metadata tree builder func
5c285f9
@anth-volk
feat: Use new tax_benefit_model_name URL param
6c41ae9
@anth-volk
fix: Add loading
8be1167
@anth-volk
fix: Fix old hook usage
5114d3e
@anth-volk
fix: Fix various tests
eb2fd19
@vercel
Copy link

vercel bot commented Jan 19, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
policyengine-app-v2 Ready Ready Preview, Comment Jan 20, 2026 1:28pm
policyengine-calculator Ready Ready Preview, Comment Jan 20, 2026 1:28pm
policyengine-website Ready Ready Preview, Comment Jan 20, 2026 1:28pm

Request Review

@anth-volk anth-volk changed the base branch from main to move-to-api-v2 January 19, 2026 20:28
@anth-volk anth-volk marked this pull request as ready for review January 20, 2026 13:37
@anth-volk anth-volk requested a review from SakshiKekre January 20, 2026 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SakshiKekre SakshiKekre Awaiting requested review from SakshiKekre

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Migrate metadata fetching to API v2 alpha

2 participants

@anth-volk